Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: sync v20 changelog #2872

Merged
merged 1 commit into from
Sep 13, 2024
Merged

chore: sync v20 changelog #2872

merged 1 commit into from
Sep 13, 2024

Conversation

gartnera
Copy link
Member

@gartnera gartnera commented Sep 12, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a Gateway address in the protocol contract list.
    • Added support for EIP-1559 gas fees.
    • Implemented functionality for migrating funds to a new ERC20Custody contract.
    • Enhanced support for Bitcoin inscriptions.
    • Integrated Protocol Contracts V2 with new metrics.
  • Bug Fixes

    • Improved validation processes in the authorization module.
    • Resolved issues with observer set duplicates and Solana deposit numbers.
  • Tests

    • Expanded the testing suite with new end-to-end tests for deposit and migration operations.

@gartnera gartnera added the no-changelog Skip changelog CI check label Sep 12, 2024
Copy link
Contributor

coderabbitai bot commented Sep 12, 2024

Walkthrough

Walkthrough

The changes in this pull request introduce significant enhancements to the Zeta Chain protocol with the release of version 20.0.0. Key updates include the addition of a Gateway address, the implementation of MsgMigrateERC20CustodyFunds, support for EIP-1559 gas fees, and the integration of Protocol Contracts V2. Refactoring efforts have improved the overall structure, while new end-to-end tests have been added to ensure robust functionality. The updates also address various validation and duplication issues, enhancing the protocol's operational integrity.

Changes

File/Path Change Summary
changelog.md Updated to reflect new features: Gateway address, MsgMigrateERC20CustodyFunds, EIP-1559 support, and V2 protocol contracts. Added new tests for migration and operations. Refactoring noted for outbound trackers and Bitcoin support.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ZetaChain
    participant ERC20Custody
    participant BitcoinSupport

    User->>ZetaChain: Initiate fund migration
    ZetaChain->>ERC20Custody: Execute MsgMigrateERC20CustodyFunds
    ERC20Custody-->>ZetaChain: Confirm migration
    ZetaChain->>User: Migration successful

    User->>ZetaChain: Request Bitcoin inscription
    ZetaChain->>BitcoinSupport: Process inscription
    BitcoinSupport-->>ZetaChain: Confirm inscription
    ZetaChain->>User: Inscription successful
Loading

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1929ff6 and 05e19c0.

Files selected for processing (1)
  • changelog.md (1 hunks)
Additional context used
LanguageTool
changelog.md

[grammar] ~40-~40: The plural noun “contracts” cannot be used with the article “a”. Did you mean “a new contract” or “new contracts”?
Context: ...rate the funds from the ERC20Custody to a new contracts (to be used for the new ERC20Custody co...

(A_NNS)

Additional comments not posted (4)
changelog.md (4)

35-36: LGTM!

The version header for v20.0.0 follows the changelog format.


39-40: LGTM!

The addition of the Gateway address to the protocol contract list and the implementation of MsgMigrateERC20CustodyFunds to migrate funds to a new ERC20Custody contract for smart contract V2 are valid features.

Tools
LanguageTool

[grammar] ~40-~40: The plural noun “contracts” cannot be used with the article “a”. Did you mean “a new contract” or “new contracts”?
Context: ...rate the funds from the ERC20Custody to a new contracts (to be used for the new ERC20Custody co...

(A_NNS)


46-47: LGTM!

The implementation of MsgUpdateERC20CustodyPauseStatus to pause or unpause the ERC20 Custody contract aligns with the migration process requirements for smart contract V2.


49-50: LGTM!

Adding support for Bitcoin inscriptions is a good feature enhancement.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@gartnera gartnera marked this pull request as ready for review September 12, 2024 20:04
@coderabbitai coderabbitai bot mentioned this pull request Dec 19, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Skip changelog CI check
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants